home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / plain / contrib / vertex / vertex.doc < prev    next >
Encoding:
Text File  |  1991-05-22  |  12.0 KB  |  290 lines
  1. \magnification=\magstep1
  2. \input vertex
  3. \input ppt.sty
  4.  
  5. \topmatter 
  6.  \title{Ver\TeX\ User's Manual} 
  7.  \author{Hal R. Varian}
  8.  \affil{University of Michigan} 
  9.  \abstract{This documentation describes Ver\TeX, a package of \TeX\ 
  10. macros that will produce beautiful working papers, and allow you to
  11. simulate final versions in a variety of journal styles.} 
  12.  \keywords{\TeX, typesetting, economics} 
  13.  \address{Prof. Hal R. Varian, Department of Economics, University of
  14. Michigan, Ann Arbor, MI 48109, U.S.A.\ \  Internet address: {\tt
  15. Hal\_Varian@UM.CC.UMICH.EDU}}
  16.  \thanks{Thanks to Kari Gluski, the participants of {\tt tex:forum},
  17. the members of the Economics Department at the University of Michigan,
  18. and all the \TeX\ hackers who made this work possible.} \date{August,
  19. 1986}
  20.  \version{\today} 
  21.  \prelim 
  22.  \endtopmatter 
  23.  \document
  24.  
  25. There are several \TeX\ macro packages already available, so why  is one
  26. more necessary?  Basically I felt that there was a need  for a simple,
  27. flexible package that added a minimum amount  to {\tt PLAIN.TEX}, and yet
  28. still provided useful features for writing technical reports.  
  29.  
  30. Ver\TeX\ will help you to {\bf V}isualize {\bf E}conomics {\bf R}eports
  31. using \TeX.  Ver\TeX\ will produce nice looking preprints and will aid in
  32. formatting your bibliography, but it will also produce simulated journal
  33. styles for a variety of economics journals.  It is very easy to add new
  34. journal styles to Ver\TeX for someone who knows a little bit of \TeX.
  35.  
  36. \section Ver\TeX\ Commands
  37.  
  38. The easiest way to show you Ver\TeX's commands is to show you the
  39. start of this paper.  It looks like something like this:
  40.  
  41. \verbatim/
  42. \magnification=\magstep1
  43. \input vertex
  44. \input ppt.sty
  45.  
  46. \topmatter 
  47.  \title{Ver\TeX\ User's Manual} 
  48.  \author{Hal R. Varian}
  49.  \affil{University of Michigan} 
  50.  \abstract{This documentation describes Ver\TeX, a package of \TeX\ 
  51. macros that will produce beautiful working papers, and allow you to
  52. simulate final versions in a variety of journal styles.} 
  53.  \keywords{\TeX, typesetting, economics} 
  54.  \address{Prof. Hal R. Varian, Department of Economics, University of
  55. Michigan, Ann Arbor, MI 48109, U.S.A.\ \  Internet address: {\tt
  56. Hal\_Varian@UM.CC.UMICH.EDU}}
  57.  \thanks{Thanks to Kari Gluski, the participants of {\tt tex:forum},
  58. the members of the Economics Department at the University of Michigan,
  59. and all the \TeX\ hackers who made this work possible.} \date{August,
  60. 1986}
  61.  \version{\today} 
  62.  \prelim 
  63.  \endtopmatter 
  64.  \document
  65.  
  66. There are several \TeX\ macro packages already available, so why  is
  67. one more necessary?  Basically I felt that there was a need  for a
  68. simple, flexible package that added a minimum amount  to {\tt
  69. PLAIN.TEX}, and yet still provided useful features for writing
  70. technical reports./
  71.  
  72. \bigskip
  73.  
  74. That's pretty simple, isn't it?  The only extra feature that you need to
  75. know is that you can put \verbatim/\cr/ into the \verbatim/\title/ macro if
  76. you want to split the title into two or more lines, as in
  77.  $$\verbatim/\title{A very, very, very, very \cr very long title}/$$
  78.  
  79. If there are two authors of a paper, use the commands
  80.  $$\verbatim/\authortwo{The Name}\affiltwo{The University}/$$
  81. The \verbatim/\thanks/ should come {\it before\/} the \verbatim/\author/
  82. and \verbatim/\title/ keywords, if the style you are using attaches the
  83. thanks as a footnote to the author or title.
  84.  
  85. What if there are more than two authors?  In that case you are on your
  86. own, except in the preprint style.  There you can do something like:
  87.  
  88. \verbatim/\author{A. Winken \cr {\it MIT} \cr B. Blinken \cr 
  89.   {\it University of California} \cr {\rm and} \cr C. Nod \cr 
  90.   {\it University of Michigan}}/
  91.  
  92. This will set the authors and affiliations up the way you want them.
  93. Be sure to leave the \verbatim/\affil/ box out if you do this trick.
  94. I intend to provide better support for multi-authored papers in the
  95. next release of Ver\TeX.
  96.  
  97. When you want to start a new section, you type
  98.  $$\verbatim/\section title of the section \par/$$
  99. and when you want to start a subsection you type
  100.  $$\verbatim/\subsection title of the subsection \par/$$
  101. Ver\TeX\ will handle the section numbers for you, automatically numbering
  102. each section as required.  
  103.  
  104. You can enter footnotes by using the construction  
  105.   $$\verbatim/\fnote{This is a footnote}/$$ and you get a
  106. footnote.\fnote{Like this!}  If at the end of your document, you type
  107. \verbatim/\PrintEndNotes/, \TeX\ will print out an end page with all your
  108. footnotes on it, for those journals who just have to have it.  
  109.  
  110. If you want the paper to be double spaced, put \verbatim#\doublespace#
  111. between \verbatim#\endtopmatter# and \verbatim#\document#.  This way the
  112. cover will come out single spaced and the document will come out double
  113. spaced, which is what people usually want.
  114.  
  115. If you are in doublespace mode and want to put a paragraph in single
  116. spaced mode for some reason, type \verbatim#\singlespace#.  The document
  117. will now revert to single spaced mode until you enter \verbatim#\doublespace#
  118. again.
  119.  
  120. One common reason to want to use single spacing in a doublespaced document
  121. is for long quotes.  Ver\TeX\ provides this via the command
  122. \verbatim/\quote/, as in \verbatim/\quote{Four score and seven $\ldots$}/.
  123.  
  124. \section Extra Goodies for Math and Figures
  125.  
  126. But there are more goodies in Ver\TeX.  For example, you can attach {\it
  127. names\/} to equations, and have \TeX\ automatically number (and renumber!)
  128. them for you.  To use this feature you type something like the following
  129. when you first introduce an equation:
  130.  $$\verbatim/$$e=mc^2\eqno\Equation\Einstein$$/$$
  131. and then when you want to reference it, you say 
  132.  $$\ldots\verbatim/as in equation (\Einstein)./$$
  133. The same sort of thing works with figures.  When you first reference a
  134. figure, called, say \verbatim/\MonaLisa/, you type
  135. \verbatim/\Fig\MonaLisa/.  \TeX\ will assign the next figure number to it
  136. and enter ``Figure 2'' (or whatever) in the text.  At the end of the
  137. paragraph, or roughly where you want the figure to appear, you
  138. type 
  139.  $$\verbatim/\Figure\MonaLisa{2in}{The great painting Mona Lisa.}/$$
  140. The three arguments to the \verbatim/\Figure/ macro are: (1) the
  141. figure name, (2) the vertical size of the figure, and (3) the 
  142. caption for the figure.  \TeX\ will insert the figure using the
  143. \verbatim/\midinsert/ command, so it will appear on the page you
  144. ask for it if there is room, and otherwise float to the top of the
  145. next page.
  146.  
  147. There are couple of things about equation and figure names that are worth 
  148. pointing out.  First, \TeX\ does not allow you to use {\it numbers\/} as
  149. part of a name.  Thus names like \verbatim/\Eq1/ and \verbatim/\Eq2/ are
  150. not allowed. However, you can {\it reuse\/} names as often as you wish. 
  151. You can refer to an equation as \verbatim/\A/ in one section of the paper
  152. and later on redefine \verbatim/\A/ to refer to another equation.  I find
  153. it  convenient to use rather long descriptive names like
  154. \verbatim/\FirstOrderCondition/ for equations that I refer to throughout the
  155. paper and use short names like \verbatim/\A/ for equations that I only
  156. refer to once or twice.
  157.  
  158. There a couple of handy math commands.  You can type \verbatim/\text{for all}/ 
  159. if you want ``for all'' to appear in math mode.  You can type
  160. \verbatim/\D{f(x)}{x_i}/ to get 
  161.  $$\D{f(x)}{x_i}$$ and
  162. \verbatim/d{f(x)}{x_i}/ to get $\d{f(x)}{x_i}$. 
  163.  
  164. The command \verbatim/\proof/ sets a nice {\it Proof.}   The command
  165. \verbatim/\qed/ gives you a box: \qed  The command \verbatim/\proclaim/
  166. works the same as described in {\it The \TeX book}, but the style has been
  167. changed slightly.
  168.  
  169. The command  \verbatim/\today/ gives today's date nicely spelled out, like:
  170. \today.
  171.  
  172. To get verbatim \TeX\ listings, use the construction 
  173.  
  174.  $$\verbatim/\verbatim#This will appear verbatim#/$$
  175.  
  176. Any convenient symbols can be used as a delimiter in place of the
  177. \verbatim/#/ signs.
  178.  
  179. \section References
  180.  
  181. Ver\TeX\ has nice way to deal with references.  You type something 
  182. like the following:
  183.  
  184. \verbatim/
  185.  
  186. \ref \by{Afriat, S.} \paper{The Construction of a Utility Function from 
  187. Expenditure Data} \jour{International Economic Review} \vol{8}
  188. \yr{1967} \pages{67--77}\endref
  189.  
  190. \ref \by{Afriat, S.} \paper{On the Constructability of Consistent Price 
  191. Indices Between Several Periods Simultaneously} \inbook{Essays in 
  192. the Theory and Measurement of Consumer Behavior in Honor of Sir 
  193. Richard Stone}\editor{A. Deaton} \publ{Cambridge University Press} 
  194. \publaddr{Cambridge, England}\yr{1984}\endref
  195.  
  196. \ref \by{Browning, M.}\paper{A Non-Parametric Test of the Life-Cycle 
  197. Rational Expectations Hypothesis} \paperinfo{Princeton University 
  198. Discussion Paper 64} \yr{1984}\endref
  199.  
  200. \ref \by{Varian, H.} \paper{Nonparametric Test of Models of Consumer 
  201. Behavior}\jour{Review of Economic Studies} \vol{50} \yr{1982b} \no{3}
  202. \pages{99--110}\endref
  203.  
  204. \ref \by{Varian, H.} \book{Microeconomic Analysis} \publ{W.
  205. W. Norton \& Co.} \publaddr{New York} \yr{1984}\endref
  206. /
  207. \medskip
  208.  
  209. and you will get a nice typeset output like:
  210.  
  211. \bigskip
  212.  
  213. \ref \by{Afriat, S.} \paper{The Construction of a Utility Function from 
  214. Expenditure Data} \jour{International Economic Review} \vol{8} 
  215. \yr{1967} \pages{67--77}\endref
  216.  
  217. \ref \by{Afriat, S.} \paper{On the Constructability of Consistent Price Indices
  218. Between Several Periods Simultaneously} \inbook{Essays in the Theory and
  219. Measurement of Consumer Behavior in Honor of Sir Richard Stone}
  220. \editor{A. Deaton} \publ{Cambridge University Press} \publaddr{Cambridge,
  221. England}\yr{1984}\endref
  222.  
  223. \ref \by{Browning, M.}\paper{A Non-Parametric Test of the Life-Cycle Rational 
  224. Expectations Hypothesis} \paperinfo{Princeton University Discussion Paper 64}
  225. \yr{1984}\endref
  226.  
  227. \ref \by{Varian, H.} \paper{Nonparametric Test of Models of Consumer
  228. Behavior} \jour{Review of Economic Studies} \vol{50} \yr{1982b} \no{3}
  229. \pages{99--110}\endref
  230.  
  231. \ref \by{Varian, H.} \book{Microeconomic Analysis} \publ{W.
  232. W. Norton \& Co.} \publaddr{New York} \yr{1984}\endref
  233.  
  234. \medskip
  235.  
  236. The reference macros are quite complicated and are still being fixed; use
  237. them at your own risk.  Currently if you omit a field that is
  238. require---like leaving out the page numbers or something like
  239. that---Ver\TeX\ will sometimes print out excess commas and other
  240. punctuation.  Eventually this will be fixed, but for now it is better to
  241. put in a dummy value, like \verbatim#\pages{???}# or something like that.
  242.  
  243. If you have a fancy reference that doesn't fit one of the above models,
  244. just use the \verbatim#\ref# macro to start the reference.  You'll get
  245. the right hanging indentation and inter-reference spacing that way.
  246.  
  247. Refer to the file \verbatim#vertex.hst# for the history of revisions to
  248. Ver\TeX.  If you add some peachy macros of your own, I strongly suggest
  249. that you put them in a separate file.  Then as new revisions of Ver\TeX\
  250. come out, you won't have to modify them in any way.
  251.  
  252. Ver\TeX\ is in the public domain; please feel free to distribute it however
  253. you want, as long as you indicate the original author.
  254.  
  255. \section Journals
  256.  
  257. Want to get published quick?  Then use Ver\TeX's journal simulation
  258. feature.  Instead of using the command \verbatim\input ppt.sty\ use
  259. the style files:
  260.  
  261. \medskip
  262.  
  263. \verbatim\jpe.sty\ --- for the {\it Journal of Polemical Economy}.
  264.  
  265. \verbatim\jep.sty\ --- for the {\it Journal of Economic Perspectives}.
  266.  
  267. \verbatim\jet.sty\ --- for the {\it Journal of Economic Theorems}.
  268.  
  269. \verbatim\aer.sty\ --- for the {\it Armenian Economic Review}.
  270.  
  271. \verbatim\ecnmet.sty\ --- for {\it Economagica}.
  272.  
  273. \verbatim\restud.sty\ --- for {\it Review for Economic Students}.
  274.  
  275. \verbatim\qje.sty\ --- for the {\it Quartered Journal of Economics}.
  276.  
  277. \medskip
  278.  
  279. When you use one of these styles, Ver\TeX\ will automatically adjust the
  280. style of the document and the style of the references to be more-or-less
  281. consistent with the journal style.  Some fine tuning may be needed, but 
  282. the output generally looks pretty good.
  283.  
  284. If you want to see a small sample of each output, \TeX\ the file {\tt
  285. vertest.tex}.
  286.  
  287. \enddocument
  288.  
  289. \bye
  290.